Package com.cisco.pt.ipc.sim
Interface AsaServiceObjectGroup
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
AsaServiceObjectGroupImpl
Information provided by the PKI file:
\class CAsaServiceObjectGroup
\brief CAsaServiceObjectGroup is service type object-group class
\example network().getDevice("Router0").getObjectManager()->getObjectByName("objectName")
\\use castTo() function to cast CAsaObject to CAsaServiceObjectGroup
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionvoidInformation provided by the PKI file:booleanaddPortObjectPortNum(String operatorString, int portNum) Information provided by the PKI file:booleanaddPortObjectPortStr(String operatorString, String strPortNum) Information provided by the PKI file:booleanaddPortRange(int startPortNum, int endPortNum) Information provided by the PKI file:booleanaddServiceObjectPortNum(String protocolString, String directionStr, String operatorString, int portNum) Information provided by the PKI file:getAclStatementAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:booleanremoveIcmp(String icmpStr, boolean isIpv4) Information provided by the PKI file:intremovePortObjectPortNum(String operatorString, int portNum) Information provided by the PKI file:intremovePortObjectPortStr(String operatorString, String strPortNum) Information provided by the PKI file:booleanremovePortRange(int startPortNum, int endPortNum) Information provided by the PKI file:intremoveServiceObjectPortNum(String protocolString, String directionStr, String operatorString, int portNum) Information provided by the PKI file:intsupportedTcpPortNameToNum(String strPortNum) Information provided by the PKI file:supportedTcpPortNameToStr(int portNum) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
addServiceObjectPortNum
boolean addServiceObjectPortNum(String protocolString, String directionStr, String operatorString, int portNum) Information provided by the PKI file:
\brief Add port setting to the service object-group service-object tcp [<destination | source > <eq | gt | lt | neq> <port>] \param protocolString, tcp/udp \param directionStr, destination/source \param operatorString, eq | gt | lt | neq \param portNum, port number \return bool, value is true if the service- Parameters:
protocolString- Takes in a parameter of protocolStringdirectionStr- Takes in a parameter of directionStroperatorString- Takes in a parameter of operatorStringportNum- Takes in a parameter of portNum- Returns:
- boolean Returns a boolean
-
addPortObjectPortNum
Information provided by the PKI file:
\brief Add port setting to the service object-group port-object eq <keyword> \param operatorString, eq \param portNum, port number \return bool, value is true if the add was successful, false if not.- Parameters:
operatorString- Takes in a parameter of operatorStringportNum- Takes in a parameter of portNum- Returns:
- boolean Returns a boolean
-
addPortObjectPortStr
Information provided by the PKI file:
\brief Add port setting to the service object-group port-object eq <keyword> \param operatorString, eq \param strPortNum, protocol associate with the port number \return bool, value is true if the add was successful, false if not.- Parameters:
operatorString- Takes in a parameter of operatorStringstrPortNum- Takes in a parameter of strPortNum- Returns:
- boolean Returns a boolean
-
removeServiceObjectPortNum
int removeServiceObjectPortNum(String protocolString, String directionStr, String operatorString, int portNum) Information provided by the PKI file:
\brief Remove port setting to the service object-group service-object tcp [<destination | source > <eq | gt | lt | neq> <port>] \param protocolString - tcp/udp \param directionStr - destination/source \param operatorString - eq | gt | lt | neq \param portNum - port number \return int, value 0 -- successful, 1 -- ACL doesn't exist, 2 -- unable to remove.- Parameters:
protocolString- Takes in a parameter of protocolStringdirectionStr- Takes in a parameter of directionStroperatorString- Takes in a parameter of operatorStringportNum- Takes in a parameter of portNum- Returns:
- int Returns a int
-
removePortObjectPortNum
Information provided by the PKI file:
\brief Remove port setting to the service object-group port-object eq <keyword> \param operatorString, eq \param portNum, port number \return int, value 0 -- successful, 1 -- ACL doesn't exist, 2 -- unable to remove.- Parameters:
operatorString- Takes in a parameter of operatorStringportNum- Takes in a parameter of portNum- Returns:
- int Returns a int
-
removePortObjectPortStr
Information provided by the PKI file:
\brief Remove port setting to the service object-group port-object eq <keyword> \param operatorString, eq \param strPortNum - protocol associate with the port number \return int, value 0 -- successful, 1 -- ACL doesn't exist, 2 -- unable to remove.- Parameters:
operatorString- Takes in a parameter of operatorStringstrPortNum- Takes in a parameter of strPortNum- Returns:
- int Returns a int
-
addPortRange
boolean addPortRange(int startPortNum, int endPortNum) Information provided by the PKI file:
\brief Add port setting to the service object-group port-object range <0-65535> <0-65535> \param startPortNum, start port number \param endPortNum, end port number \return bool, value is true if the port range could be added, false if not.- Parameters:
startPortNum- Takes in a parameter of startPortNumendPortNum- Takes in a parameter of endPortNum- Returns:
- boolean Returns a boolean
-
removePortRange
boolean removePortRange(int startPortNum, int endPortNum) Information provided by the PKI file:
\brief Remove port setting to the service object-group port-object range <0-65535> <0-65535> \param startPortNum, start port number \param endPortNum, end port number \return bool, value is true if the port range could be removed, false if not.- Parameters:
startPortNum- Takes in a parameter of startPortNumendPortNum- Takes in a parameter of endPortNum- Returns:
- boolean Returns a boolean
-
addIcmp
Information provided by the PKI file:
\brief Add service type icmp service-object icmp/icmp6 [echo | echo-reply] \param icmpStr, echo/echo-reply \param isIpv4, true for ipv4 and false for ipv6- Parameters:
icmpStr- Takes in a parameter of icmpStrisIpv4- Takes in a parameter of isIpv4
-
removeIcmp
Information provided by the PKI file:
\brief Remove service type icmp service-object icmp/icmp6 [echo | echo-reply] \param icmpStr, echo/echo-reply \param isIpv4, true for ipv4 and false for ipv6 return bool, value is true if the removal was successful, false if not.- Parameters:
icmpStr- Takes in a parameter of icmpStrisIpv4- Takes in a parameter of isIpv4- Returns:
- boolean Returns a boolean
-
getAclStatementCount
int getAclStatementCount()Information provided by the PKI file:
\brief Returns the number of acl statements generated by this object-group return int, value is the number of acl statements generated by this object-group.- Returns:
- int Returns a int
-
getAclStatementAt
Information provided by the PKI file:
\brief Returns the acl statement at a specific index \param index, index to get the statment from. Range (0, getAclStatementCount()). \return AclStatement, Acl state at the specified index, if it exists.- Parameters:
index- Takes in a parameter of index- Returns:
- ACLStatement Returns a ACLStatement
-
getRunningConfig
Information provided by the PKI file:
\brief Returns the string configuration of the object \return vector<string>, value is the string configurations of the object.- Returns:
- List<String> Returns a List<String>
-
supportedTcpPortNameToStr
Information provided by the PKI file:
\brief Returns tcp protocol associate with the port number \param portNum, port number to find the associated tcp protocal for. \return string, value is the tcp protocol assoiated with the port number- Parameters:
portNum- Takes in a parameter of portNum- Returns:
- String Returns a String
-
supportedTcpPortNameToNum
Information provided by the PKI file:
\brief Returns the port number based on protocol name \param strPortNum, protocol that associates with port number. \return int, value is port number based on protocol name.- Parameters:
strPortNum- Takes in a parameter of strPortNum- Returns:
- int Returns a int
-